<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>run: common_schema documentation</title>
	<meta name="description" content="run: common_schema" />
	<meta name="keywords" content="run: common_schema" />
	<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>common_schema</h1> <strong>2.2</strong> documentation
			<div class="subtitle">DBA's framework for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="run.html">run</a></h2>	
<h3>NAME</h3>
run(): Executes a QueryScript.

<h3>TYPE</h3>
Procedure

<h3>DESCRIPTION</h3>
<p>
	This procedure accepts a <a href="query_script.html">QueryScript</a> text, and invokes the script.
</p>
<p>
	<i>run()</i> is the main entry point for QueryScript.</p>
<p>
	<i>run()</i> will first scan the code for script syntax errors. Any such error aborts operation. Only when satisfied,
	is the code executed. Hence, although a QueryScript code is interpreted, syntax errors are intercepted before any 
	code executes. It should be noted that SQL syntax errors are not examined, only script syntax error. Read more on
	<a href="query_script_execution.html">Execution</a>.
</p>
<p>
	Failure of execution or interpretation is prompted to the user. The <strong>@common_schema_error</strong> variables is
	set with the relevant error message.
</p>
<p>
	Invoker of this procedure must have the privileges required for execution of queries in the script.
</p>

<h3>SYNOPSIS</h3>
<p>
<blockquote><pre>run(IN query_script text)
  MODIFIES SQL DATA</pre></blockquote>
</p>
<p>
  Input: 
  <ul>
    <li><strong>query_script</strong>: a <a href="query_script.html">QueryScript</a> text. <i>run()</i> also accepts a filename, if it starts
    	with a slash (<strong>/</strong>) or a backslash (<strong>\</strong>).
	</li>
  </ul>
</p>
<p>
Invocation of <i>run()</i> is likely to generate many warnings. These should be ignored, and are part of the
general workflow (e.g. removing some temporary tables if they exist).
</p>

<h3>EXAMPLES</h3>
	<p>
		Execute an inlined script:
	</p>
	<blockquote><pre>mysql&gt; call run("
  foreach($x : 1:8)
  {
    CREATE DATABASE shard_:$x;
  }
  SHOW DATABASES LIKE 'shard_%';
");

+--------------------+
| Database (shard_%) |
+--------------------+
| shard_1            |
| shard_2            |
| shard_3            |
| shard_4            |
| shard_5            |
| shard_6            |
| shard_7            |
| shard_8            |
+--------------------+
</pre></blockquote>
The above assumes no <a href="http://dev.mysql.com/doc/refman/5.1/en/server-sql-mode.html#sqlmode_ansi_quotes"><strong>ANSI_QUOTES</strong></a> 
in <strong>sql_mode</strong>.

	<p>
		Run script stored in user defined text variable. Repeatedly execute random queries until 5pm:
	</p>
	<blockquote><pre>mysql&gt; SET @script := "
while (TIME(SYSDATE()) < '17:00:00')
  SELECT * FROM world.City WHERE id = 1 + FLOOR((RAND()*4079));
";
mysql&gt; call run(@script);
</pre></blockquote>


<h3>ENVIRONMENT</h3>
MySQL 5.1 or newer

<h3>SEE ALSO</h3>
<a href="query_script.html">Query Script</a>,
<a href="run_file.html">run_file()</a>

<h3>AUTHOR</h3>
Shlomi Noach
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="search">
					Search online documentation
					<form id="search_form" name="search_form" method="GET" 
						action="http://www.google.com/search" 
						onsubmit="document.forms['search_form']['q'].value = 'site:http://common-schema.googlecode.com/svn/trunk/common_schema/doc/html/ '+document.forms['search_form']['search_term'].value;">
						<input type="text" name="search_term" value=""/>
						<input type="hidden" name="q" value=""/>
						<input type="submit" value="go"/>						
					</form>
				</div>
				<div id="menu">
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Documentation" href="documentation.html">Documentation</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="Risks" href="risks.html">Risks</a></li>
					</ul>						
					<h3>QUERY SCRIPT</h3>
					<ul>
						<li><a title="QueryScript" href="query_script.html">QueryScript</a></li>
						<li><a title="Execution" href="query_script_execution.html">Execution</a></li>
						<li><a title="Flow control" href="query_script_flow_control.html">Flow control</a></li>
						<li><a title="Statements" href="query_script_statements.html">Statements</a></li>
						<li><a title="Expressions" href="query_script_expressions.html">Expressions</a></li>
						<li><a title="Variables" href="query_script_variables.html">Variables</a></li>
					</ul>						
					<h3>DEBUG</h3>
					<ul>
						<li><a title="rdebug" href="rdebug.html">rdebug</a></li>
						<li><a title="rdebug API" href="rdebug_api.html">rdebug API</a></li>
						<li><a title="rdebug workflow" href="rdebug_workflow.html">Workflow</a></li>
					</ul>						
					<h3>ROUTINES</h3>
					<ul>
						<li><a title="Execution &amp; flow control" href="execution_routines.html">Execution & flow control</a></li>
						<li><a title="General" href="general_routines.html">General</a></li>
						<li><a title="Process" href="process_routines.html">Process</a></li>
						<li><a title="Query analysis" href="query_analysis_routines.html">Query analysis</a></li>
						<li><a title="Schema analysis" href="schema_analysis_routines.html">Schema analysis</a></li>
						<li><a title="Security" href="security_routines.html">Security</a></li>
						<li><a title="Text" href="text_routines.html">Text</a></li>
						<li><a title="Time &amp; date" href="temporal_routines.html">Time & date</a></li>
						<li><a title="Charting" href="charting_routines.html">Charting</a></li>
					</ul>
					<h3>VIEWS</h3>
					<ul>
						<li><a title="Schema analysis" href="schema_analysis_views.html">Schema analysis</a></li>
						<li><a title="Data dimension" href="data_dimension_views.html">Data dimension</a></li>
						<li><a title="Process" href="process_views.html">Process</a></li>
						<li><a title="Security" href="security_views.html">Security</a></li>
						<li><a title="Monitoring" href="monitoring_views.html">Monitoring</a></li>
						<li><a title="InnoDB Plugin" href="innodb_plugin_views.html">InnoDB Plugin</a></li>
						<li><a title="Percona server" href="percona_server_views.html">Percona Server</a></li>
						<li><a title="TokuDB" href="tokudb_views.html">TokuDB</a></li>
					</ul>						
					<h3>DATA</h3>
					<ul>
						<li><a title="tables" href="tables.html">Tables</a></li>
						<li><a title="variables" href="variables.html">Variables</a></li>
					</ul>						
					<h3>META</h3>
					<ul>
						<li><a title="Help" href="help.html">help</a></li>
						<li><a title="Metadata" href="metadata.html">metadata</a></li>
						<li><a title="status" href="status.html">status</a></li>
					</ul>						
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">common_schema</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
